Data Query Tool (DQT) API Reporting

The AdBook Data Query Tool (DQT) is the core reporting engine for the platform. The API endpoint provides methods for executing a ReportJob and retrieving comprehensive and targeted access to both standard AdBook data as well as custom (user defined) fields specific to your organization.

 

To execute a DQT report, follow the steps outlined below:

1. Assemble a ReportQuery object or retrieve an existing ReportQuery object from a report saved through the AdBook UI
2. Submit the ReportQuery object by calling RunReportJob
3. Poll the status of the report using the ReportJobID returned from RunReportJob in step 2 by calling GetReportJob
   1. Continue to poll until the Status field of the response is equal to Done or Error
4. Once the status is done, retrieve the download URL for the CSV file by calling GetReportDownloadURL

 

Operations

RunReportJob, GetReportJob, GetReportDownloadURL, GetFieldOutputColumnList, GetDeliveryDetailOutputColumnList, 

GetMetricOutputColumnList, GetQueryFilterValueList, GetQueryParameterList, GetSavedReportList, GetSavedReportQuery

 

---

Media Tree API Reporting

AbBook's API endpoint allows the Media Tree, or product catalog, to be exported to CSV. This allows for creating new or modifying existing products, but it's also a great way to review the product catalog at a glance or provide exports to users who need to be familiar with the product catalog hierarchy or metadata.

 

To execute a Media Tree report, follow the steps outlined below:

1. Assemble a MediaTreeReportQuery object or retrieve an existing MediaTreeReportQuery object from a report saved through the AdBook UI
2. Submit the MediaTreeReportQuery object by calling RunMediaTreeReportJob
3. Poll the status of the report using the MediaTreeReportJobID returned from RunMediaTreeReportJob in step 2 by calling GetMediaTreeReportJob
   1. Continue to poll until the Status field of the response is equal to Done or Error
4. Once the status is done, retrieve the download URL for the CSV file by calling GetReportDownloadURL

 

Operations

 RunMediaTreeReportJob, GetMediaTreeReportJob

 

---

Additional Information

The parameters for each element in the ReportQuery object represent criteria or filters in DQT and can be modified accordingly to build reports and access data in a way that meets your individual or organizational needs.

1. Available output columns can be accessed by calling GetFieldOutputColumnList, GetDeliveryDetailOutputColumnList, and GetMetricOutputColumnList
2. Available filter values can be accessed (by type) by calling GetQueryFilterValueList
3. Available parameter lists can be accessed (by type) by calling GetQueryParameterList

To retrieve a ReportQuery object from an existing report saved through the UI:

1. Get a list of existing saved report parameters by calling GetSavedReportList
   1. Available reports are saved from the Data Query Tool on the UI
2. Retrieve the ReportQuery object for the saved report by calling GetSavedReportQuery with the selected savedReportID from step 1